Add a note for --start-at-task #1706
Conversation
add a note stating what --start-at-task can and cannot address Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
| .. note:: | ||
|
|
||
| Moreover, ``--start-at-task`` | ||
| - can target tasks **within** static includes |
There was a problem hiding this comment.
within imports (which are static) .. dont say 'static includes' as that would be a contradiction in our terminology, in which all includes are dynamic
There was a problem hiding this comment.
same with below, just establish import == static/preprocessed, include ==dynamic/executed at runtime
| @@ -19,6 +19,14 @@ To start executing your playbook at a particular task (usually the task that fai | |||
|
|
|||
| In this example, Ansible starts executing your playbook at a task named "install packages". This feature does not work with tasks inside dynamically re-used roles or tasks (``include_*``), see :ref:`dynamic_vs_static`. | |||
There was a problem hiding this comment.
| In this example, Ansible starts executing your playbook at a task named "install packages". This feature does not work with tasks inside dynamically re-used roles or tasks (``include_*``), see :ref:`dynamic_vs_static`. | |
| In this example, Ansible starts executing your playbook at a task named "install packages". |
| @@ -19,6 +19,14 @@ To start executing your playbook at a particular task (usually the task that fai | |||
|
|
|||
| In this example, Ansible starts executing your playbook at a task named "install packages". This feature does not work with tasks inside dynamically re-used roles or tasks (``include_*``), see :ref:`dynamic_vs_static`. | |||
|
|
|||
| .. note:: | |||
|
|
|||
| Moreover, ``--start-at-task`` | |||
There was a problem hiding this comment.
| Moreover, ``--start-at-task`` | |
| The ``--start-at-task`` feature does not work with reused tasks in all cases. This depends on if the reuse is dynamic or static. | |
| - If dynamically reused with an ``include_*`` statement, ``--start-at-task`` can target the task itself but not tasks inside the included role or task. | |
| - If statically reused with an ``import_*`` statement, ``--start-at-task`` can target tasks inside the imported role or task but not the task itself. | |
| For more information about are inside roles or tasks (), see :ref:`dynamic_vs_static`. |
|
Hi @Akasurde We've made some changes to the underlying readthedocs project for this repository. I'm going to close and re-open this issue to kick off a new PR preview build. You might notice there will be two checks for readthedocs. One for The Thank you for your patience and understanding. |
SUMMARY
add a note stating what --start-at-task can and cannot address
Signed-off-by: Abhijeet Kasurde akasurde@redhat.com
ISSUE TYPE